<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QDesignerFormWindowInterface Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QDesignerFormWindowInterface Class Reference<br /><sup><sup>[<a href="qtdesigner.html">QtDesigner</a> module]</sup></sup></h1><p>The QDesignerFormWindowInterface class allows you to query and
manipulate form windows appearing in Qt Designer's workspace.
<a href="#details">More...</a></p>

<p>Inherits <a href="qwidget.html">QWidget</a>.</p><h3>Types</h3><ul><li><div class="fn" />class <b><a href="qdesignerformwindowinterface-feature.html">Feature</a></b></li><li><div class="fn" />enum <b><a href="qdesignerformwindowinterface.html#FeatureFlag-enum">FeatureFlag</a></b> { EditFeature, GridFeature, TabOrderFeature, DefaultFeature }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#QDesignerFormWindowInterface">__init__</a></b> (<i>self</i>, QWidget&#160;<i>parent</i>&#160;=&#160;None, Qt.WindowFlags&#160;<i>flags</i>&#160;=&#160;0)</li><li><div class="fn" />QDir <b><a href="qdesignerformwindowinterface.html#absoluteDir">absoluteDir</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#addResourceFile">addResourceFile</a></b> (<i>self</i>, QString&#160;<i>path</i>)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#author">author</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#clearSelection">clearSelection</a></b> (<i>self</i>, bool&#160;<i>update</i>&#160;=&#160;True)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#comment">comment</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#contents">contents</a></b> (<i>self</i>)</li><li><div class="fn" />QDesignerFormEditorInterface <b><a href="qdesignerformwindowinterface.html#core">core</a></b> (<i>self</i>)</li><li><div class="fn" />QDesignerFormWindowCursorInterface <b><a href="qdesignerformwindowinterface.html#cursor">cursor</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#emitSelectionChanged">emitSelectionChanged</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#exportMacro">exportMacro</a></b> (<i>self</i>)</li><li><div class="fn" />Feature <b><a href="qdesignerformwindowinterface.html#features">features</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#fileName">fileName</a></b> (<i>self</i>)</li><li><div class="fn" />QPoint <b><a href="qdesignerformwindowinterface.html#grid">grid</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qdesignerformwindowinterface.html#hasFeature">hasFeature</a></b> (<i>self</i>, Feature&#160;<i>f</i>)</li><li><div class="fn" />QStringList <b><a href="qdesignerformwindowinterface.html#includeHints">includeHints</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qdesignerformwindowinterface.html#isDirty">isDirty</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qdesignerformwindowinterface.html#isManaged">isManaged</a></b> (<i>self</i>, QWidget&#160;<i>widget</i>)</li><li><div class="fn" />(int&#160;<i>margin</i>, int&#160;<i>spacing</i>) <b><a href="qdesignerformwindowinterface.html#layoutDefault">layoutDefault</a></b> (<i>self</i>)</li><li><div class="fn" />(QString&#160;<i>margin</i>, QString&#160;<i>spacing</i>) <b><a href="qdesignerformwindowinterface.html#layoutFunction">layoutFunction</a></b> (<i>self</i>)</li><li><div class="fn" />QWidget <b><a href="qdesignerformwindowinterface.html#mainContainer">mainContainer</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#manageWidget">manageWidget</a></b> (<i>self</i>, QWidget&#160;<i>widget</i>)</li><li><div class="fn" />QString <b><a href="qdesignerformwindowinterface.html#pixmapFunction">pixmapFunction</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#removeResourceFile">removeResourceFile</a></b> (<i>self</i>, QString&#160;<i>path</i>)</li><li><div class="fn" />QStringList <b><a href="qdesignerformwindowinterface.html#resourceFiles">resourceFiles</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#selectWidget">selectWidget</a></b> (<i>self</i>, QWidget&#160;<i>widget</i>, bool&#160;<i>select</i>&#160;=&#160;True)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setAuthor">setAuthor</a></b> (<i>self</i>, QString&#160;<i>author</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setComment">setComment</a></b> (<i>self</i>, QString&#160;<i>comment</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setContents">setContents</a></b> (<i>self</i>, QIODevice&#160;<i>dev</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setContents-2">setContents</a></b> (<i>self</i>, QString&#160;<i>contents</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setDirty">setDirty</a></b> (<i>self</i>, bool&#160;<i>dirty</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setExportMacro">setExportMacro</a></b> (<i>self</i>, QString&#160;<i>exportMacro</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setFeatures">setFeatures</a></b> (<i>self</i>, Feature&#160;<i>f</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setFileName">setFileName</a></b> (<i>self</i>, QString&#160;<i>fileName</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setGrid">setGrid</a></b> (<i>self</i>, QPoint&#160;<i>grid</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setIncludeHints">setIncludeHints</a></b> (<i>self</i>, QStringList&#160;<i>includeHints</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setLayoutDefault">setLayoutDefault</a></b> (<i>self</i>, int&#160;<i>margin</i>, int&#160;<i>spacing</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setLayoutFunction">setLayoutFunction</a></b> (<i>self</i>, QString&#160;<i>margin</i>, QString&#160;<i>spacing</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setMainContainer">setMainContainer</a></b> (<i>self</i>, QWidget&#160;<i>mainContainer</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#setPixmapFunction">setPixmapFunction</a></b> (<i>self</i>, QString&#160;<i>pixmapFunction</i>)</li><li><div class="fn" /><b><a href="qdesignerformwindowinterface.html#unmanageWidget">unmanageWidget</a></b> (<i>self</i>, QWidget&#160;<i>widget</i>)</li></ul><h3>Static Methods</h3><ul><li><div class="fn" />QDesignerFormWindowInterface <b><a href="qdesignerformwindowinterface.html#findFormWindow">findFormWindow</a></b> (QWidget&#160;<i>w</i>)</li><li><div class="fn" />QDesignerFormWindowInterface <b><a href="qdesignerformwindowinterface.html#findFormWindow-2">findFormWindow</a></b> (QObject&#160;<i>obj</i>)</li></ul><h3>Qt Signals</h3><ul><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#aboutToUnmanageWidget">aboutToUnmanageWidget</a></b> (QWidget *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#activated">activated</a></b> (QWidget *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#changed">changed</a></b> ()</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#featureChanged">featureChanged</a></b> (QDesignerFormWindowInterface::Feature)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#fileNameChanged">fileNameChanged</a></b> (const QString&amp;)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#geometryChanged">geometryChanged</a></b> ()</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#mainContainerChanged">mainContainerChanged</a></b> (QWidget *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#objectRemoved">objectRemoved</a></b> (QObject *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#resourceFilesChanged">resourceFilesChanged</a></b> ()</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#selectionChanged">selectionChanged</a></b> ()</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#widgetManaged">widgetManaged</a></b> (QWidget *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#widgetRemoved">widgetRemoved</a></b> (QWidget *)</li><li><div class="fn" />void <b><a href="qdesignerformwindowinterface.html#widgetUnmanaged">widgetUnmanaged</a></b> (QWidget *)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QDesignerFormWindowInterface class allows you to query and
manipulate form windows appearing in Qt Designer's workspace.</p>
<p>QDesignerFormWindowInterface provides information about the
associated form window as well as allowing its properties to be
altered. The interface is not intended to be instantiated directly,
but to provide access to <i>Qt Designer</i>'s current form windows
controlled by <i>Qt Designer</i>'s <a href="qdesignerformwindowmanagerinterface.html">form window
manager</a>.</p>
<p>If you are looking for the form window containing a specific
widget, you can use the static <a href="qdesignerformwindowinterface.html#findFormWindow">QDesignerFormWindowInterface.findFormWindow</a>()
function:</p>
<pre class="cpp">
     <span class="type">QDesignerFormWindowInterface</span> <span class="operator">*</span>formWindow;
     formWindow <span class="operator">=</span> <span class="type">QDesignerFormWindowInterface</span><span class="operator">.</span><a href="qdesignerformwindowinterface.html#findFormWindow">findFormWindow</a>(myWidget);
</pre>
<p>But in addition, you can access any of the current form windows
through <i>Qt Designer</i>'s form window manager: Use the <a href="qdesignerformeditorinterface.html#formWindowManager">QDesignerFormEditorInterface.formWindowManager</a>()
function to retrieve an interface to the manager. Once you have
this interface, you have access to all of <i>Qt Designer</i>'s
current form windows through the <a href="qdesignerformwindowmanagerinterface.html#formWindow">QDesignerFormWindowManagerInterface.formWindow</a>()
function. For example:</p>
<pre class="cpp">
     <span class="type"><a href="qlist.html">QList</a></span><span class="operator">&lt;</span><span class="type">QDesignerFormWindowInterface</span> <span class="operator">*</span><span class="operator">&gt;</span> forms;
     <span class="type">QDesignerFormWindowInterface</span> <span class="operator">*</span>formWindow;

     <span class="type"><a href="qdesignerformwindowmanagerinterface.html">QDesignerFormWindowManagerInterface</a></span> <span class="operator">*</span>manager <span class="operator">=</span> formEditor<span class="operator">-</span><span class="operator">&gt;</span>formWindowManager();

     <span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">0</span>; i <span class="operator">&lt;</span> manager<span class="operator">-</span><span class="operator">&gt;</span>formWindowCount(); i<span class="operator">+</span><span class="operator">+</span>) {
         formWindow <span class="operator">=</span> manager<span class="operator">-</span><span class="operator">&gt;</span>formWindow(i);
         forms<span class="operator">.</span>append(formWindow);
     }
</pre>
<p>The pointer to <i>Qt Designer</i>'s current <a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a>
object (<tt>formEditor</tt> in the example above) is provided by
the <a href="qdesignercustomwidgetinterface.html#initialize">QDesignerCustomWidgetInterface.initialize</a>()
function's parameter. When implementing a custom widget plugin, you
must subclass the <a href="qdesignercustomwidgetinterface.html">QDesignerCustomWidgetInterface</a>
class to expose your plugin to <i>Qt Designer</i>.</p>
<p>Once you have the form window, you can query its properties. For
example, a plain custom widget plugin is managed by <i>Qt
Designer</i> only at its top level, i.e. none of its child widgets
can be resized in <i>Qt Designer</i>'s workspace. But
QDesignerFormWindowInterface provides you with functions that
enables you to control whether a widget should be managed by <i>Qt
Designer</i>, or not:</p>
<pre class="cpp">
         <span class="keyword">if</span> (formWindow<span class="operator">-</span><span class="operator">&gt;</span>isManaged(myWidget))
             formWindow<span class="operator">-</span><span class="operator">&gt;</span><a href="qdesignerformwindowinterface.html#manageWidget">manageWidget</a>(myWidget<span class="operator">-</span><span class="operator">&gt;</span>childWidget);
</pre>
<p>The complete list of functions concerning widget management is:
<a href="qdesignerformwindowinterface.html#isManaged">isManaged</a>(),
<a href="qdesignerformwindowinterface.html#manageWidget">manageWidget</a>()
and <a href="qdesignerformwindowinterface.html#unmanageWidget">unmanageWidget</a>().
There is also several associated signals: <a href="qdesignerformwindowinterface.html#widgetManaged">widgetManaged</a>(),
<a href="qdesignerformwindowinterface.html#widgetRemoved">widgetRemoved</a>(),
<a href="qdesignerformwindowinterface.html#aboutToUnmanageWidget">aboutToUnmanageWidget</a>()
and <a href="qdesignerformwindowinterface.html#widgetUnmanaged">widgetUnmanaged</a>().</p>
<p>In addition to controlling the management of widgets, you can
control the current selection in the form window using the <a href="qdesignerformwindowinterface.html#selectWidget">selectWidget</a>(),
<a href="qdesignerformwindowinterface.html#clearSelection">clearSelection</a>()
and <a href="qdesignerformwindowinterface.html#emitSelectionChanged">emitSelectionChanged</a>()
functions, and the <a href="qdesignerformwindowinterface.html#selectionChanged">selectionChanged</a>()
signal.</p>
<p>You can also retrieve information about where the form is stored
using <a href="qdesignerformwindowinterface.html#absoluteDir">absoluteDir</a>(),
its include files using <a href="qdesignerformwindowinterface.html#includeHints">includeHints</a>(),
and its layout and pixmap functions using <a href="qdesignerformwindowinterface.html#layoutDefault">layoutDefault</a>(),
<a href="qdesignerformwindowinterface.html#layoutFunction">layoutFunction</a>()
and <a href="qdesignerformwindowinterface.html#pixmapFunction">pixmapFunction</a>().
You can find out whether the form window has been modified (but not
saved) or not, using the <a href="qdesignerformwindowinterface.html#isDirty">isDirty</a>() function.
You can retrieve its <a href="qdesignerformwindowinterface.html#author">author</a>(), its
<a href="qdesignerformwindowinterface.html#contents">contents</a>(), its
<a href="qdesignerformwindowinterface.html#fileName">fileName</a>(),
associated <a href="qdesignerformwindowinterface.html#comment">comment</a>() and
<a href="qdesignerformwindowinterface.html#exportMacro">exportMacro</a>(),
its <a href="qdesignerformwindowinterface.html#mainContainer">mainContainer</a>(),
its <a href="qdesignerformwindowinterface.html#features">features</a>(), its
<a href="qdesignerformwindowinterface.html#grid">grid</a>() and its
<a href="qdesignerformwindowinterface.html#resourceFiles">resourceFiles</a>().</p>
<p>The interface provides you with functions and slots allowing you
to alter most of this information as well. The exception is the
directory storing the form window. Finally, there is several
signals associated with changes to the information mentioned above
and to the form window in general.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="FeatureFlag-enum" />QDesignerFormWindowInterface.FeatureFlag</h3><p>This enum describes the features that are available and can be
controlled by the form window interface. These values are used when
querying the form window to determine which features it
supports:</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign">
<tt>QDesignerFormWindowInterface.EditFeature</tt></td>
<td class="topAlign"><tt>0x01</tt></td>
<td class="topAlign">Form editing</td>
</tr>
<tr>
<td class="topAlign">
<tt>QDesignerFormWindowInterface.GridFeature</tt></td>
<td class="topAlign"><tt>0x02</tt></td>
<td class="topAlign">Grid display and snap-to-grid facilities for
editing</td>
</tr>
<tr>
<td class="topAlign">
<tt>QDesignerFormWindowInterface.TabOrderFeature</tt></td>
<td class="topAlign"><tt>0x04</tt></td>
<td class="topAlign">Tab order management</td>
</tr>
<tr>
<td class="topAlign">
<tt>QDesignerFormWindowInterface.DefaultFeature</tt></td>
<td class="topAlign"><tt>EditFeature | GridFeature</tt></td>
<td class="topAlign">Support for default features (form editing and
grid)</td>
</tr>
</table>
<p>The Feature type is a typedef for <a href="qflags.html">QFlags</a>&lt;FeatureFlag&gt;. It stores an OR
combination of FeatureFlag values.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#hasFeature">hasFeature</a>() and
<a href="qdesignerformwindowinterface.html#features">features</a>().</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QDesignerFormWindowInterface" />QDesignerFormWindowInterface.__init__ (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>parent</i>&#160;=&#160;None, <a href="qt-windowflags.html">Qt.WindowFlags</a>&#160;<i>flags</i>&#160;=&#160;0)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a form window interface with the given <i>parent</i>
and the specified window <i>flags</i>.</p>


<h3 class="fn"><a name="absoluteDir" /><a href="qdir.html">QDir</a> QDesignerFormWindowInterface.absoluteDir (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the absolute location of the directory containing the
form shown in the form window.</p>


<h3 class="fn"><a name="addResourceFile" />QDesignerFormWindowInterface.addResourceFile (<i>self</i>, QString&#160;<i>path</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Adds the resource file at the given <i>path</i> to those used by
the form.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#resourceFiles">resourceFiles</a>()
and <a href="qdesignerformwindowinterface.html#resourceFilesChanged">resourceFilesChanged</a>().</p>


<h3 class="fn"><a name="author" />QString QDesignerFormWindowInterface.author (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns details of the author or creator of the form currently
being displayed in the window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setAuthor">setAuthor</a>().</p>


<h3 class="fn"><a name="clearSelection" />QDesignerFormWindowInterface.clearSelection (<i>self</i>, bool&#160;<i>update</i>&#160;=&#160;True)</h3><p>This method is also a Qt slot with the C++ signature <tt>void clearSelection(bool = 1)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Clears the current selection in the form window. If
<i>update</i> is true, the <a href="qdesignerformwindowinterface.html#emitSelectionChanged">emitSelectionChanged</a>()
function is called, emitting the <a href="qdesignerformwindowinterface.html#selectionChanged">selectionChanged</a>()
signal.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#selectWidget">selectWidget</a>().</p>


<h3 class="fn"><a name="comment" />QString QDesignerFormWindowInterface.comment (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns comments about the form currently being displayed in the
window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setComment">setComment</a>().</p>


<h3 class="fn"><a name="contents" />QString QDesignerFormWindowInterface.contents (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns details of the contents of the form currently being
displayed in the window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setContents">setContents</a>().</p>


<h3 class="fn"><a name="core" /><a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a> QDesignerFormWindowInterface.core (<i>self</i>)</h3><p>Returns a pointer to <i>Qt Designer</i>'s current <a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a>
object.</p>


<h3 class="fn"><a name="cursor" /><a href="qdesignerformwindowcursorinterface.html">QDesignerFormWindowCursorInterface</a> QDesignerFormWindowInterface.cursor (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the cursor interface used by the form window.</p>


<h3 class="fn"><a name="emitSelectionChanged" />QDesignerFormWindowInterface.emitSelectionChanged (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Emits the <a href="qdesignerformwindowinterface.html#selectionChanged">selectionChanged</a>()
signal.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#selectWidget">selectWidget</a>()
and <a href="qdesignerformwindowinterface.html#clearSelection">clearSelection</a>().</p>


<h3 class="fn"><a name="exportMacro" />QString QDesignerFormWindowInterface.exportMacro (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the export macro associated with the form currently
being displayed in the window. The export macro is used when the
form is compiled to create a widget plugin.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setExportMacro">setExportMacro</a>()
and <a href="designer-creating-custom-widgets.html">Creating Custom
Widgets for Qt Designer</a>.</p>


<h3 class="fn"><a name="features" /><a href="qdesignerformwindowinterface-feature.html">Feature</a> QDesignerFormWindowInterface.features (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns a combination of the features provided by the form
window associated with the interface. The value returned can be
tested against the <a href="qdesignerformwindowinterface.html#FeatureFlag-enum">Feature</a>
enum values to determine which features are supported by the
window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setFeatures">setFeatures</a>()
and <a href="qdesignerformwindowinterface.html#hasFeature">hasFeature</a>().</p>


<h3 class="fn"><a name="fileName" />QString QDesignerFormWindowInterface.fileName (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the file name of the UI file that describes the form
currently being shown.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setFileName">setFileName</a>().</p>


<h3 class="fn"><a name="findFormWindow" /><a href="qdesignerformwindowinterface.html">QDesignerFormWindowInterface</a> QDesignerFormWindowInterface.findFormWindow (<a href="qwidget.html">QWidget</a>&#160;<i>w</i>)</h3><p>Returns the form window interface for the given
<i>widget</i>.</p>


<h3 class="fn"><a name="findFormWindow-2" /><a href="qdesignerformwindowinterface.html">QDesignerFormWindowInterface</a> QDesignerFormWindowInterface.findFormWindow (<a href="qobject.html">QObject</a>&#160;<i>obj</i>)</h3><p>Returns the form window interface for the given
<i>object</i>.</p>
<p>This function was introduced in Qt 4.4.</p>


<h3 class="fn"><a name="grid" /><a href="qpoint.html">QPoint</a> QDesignerFormWindowInterface.grid (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the grid spacing used by the form window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setGrid">setGrid</a>().</p>


<h3 class="fn"><a name="hasFeature" />bool QDesignerFormWindowInterface.hasFeature (<i>self</i>, <a href="qdesignerformwindowinterface-feature.html">Feature</a>&#160;<i>f</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the form window offers the specified
<i>feature</i>; otherwise returns false.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#features">features</a>().</p>


<h3 class="fn"><a name="includeHints" />QStringList QDesignerFormWindowInterface.includeHints (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns a list of the header files that will be included in the
form window's associated UI file.</p>
<p>Header files may be local, i.e. relative to the project's
directory, <tt>"mywidget.h"</tt>, or global, i.e. part of Qt or the
compilers standard libraries: <tt>&lt;QtGui/QWidget&gt;</tt>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setIncludeHints">setIncludeHints</a>().</p>


<h3 class="fn"><a name="isDirty" />bool QDesignerFormWindowInterface.isDirty (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the form window is "dirty" (modified but not
saved); otherwise returns false.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setDirty">setDirty</a>().</p>


<h3 class="fn"><a name="isManaged" />bool QDesignerFormWindowInterface.isManaged (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>widget</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the specified <i>widget</i> is managed by the
form window; otherwise returns false.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#manageWidget">manageWidget</a>().</p>


<h3 class="fn"><a name="layoutDefault" />(int&#160;<i>margin</i>, int&#160;<i>spacing</i>) QDesignerFormWindowInterface.layoutDefault (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Fills in the default margin and spacing for the form's default
layout in the <i>margin</i> and <i>spacing</i> variables
specified.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setLayoutDefault">setLayoutDefault</a>().</p>


<h3 class="fn"><a name="layoutFunction" />(QString&#160;<i>margin</i>, QString&#160;<i>spacing</i>) QDesignerFormWindowInterface.layoutFunction (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Fills in the current margin and spacing for the form's layout in
the <i>margin</i> and <i>spacing</i> variables specified.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setLayoutFunction">setLayoutFunction</a>().</p>


<h3 class="fn"><a name="mainContainer" /><a href="qwidget.html">QWidget</a> QDesignerFormWindowInterface.mainContainer (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the main container widget for the form window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setMainContainer">setMainContainer</a>().</p>


<h3 class="fn"><a name="manageWidget" />QDesignerFormWindowInterface.manageWidget (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>widget</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void manageWidget(QWidget *)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Instructs the form window to manage the specified
<i>widget</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#isManaged">isManaged</a>(),
<a href="qdesignerformwindowinterface.html#unmanageWidget">unmanageWidget</a>(),
and <a href="qdesignerformwindowinterface.html#widgetManaged">widgetManaged</a>().</p>


<h3 class="fn"><a name="pixmapFunction" />QString QDesignerFormWindowInterface.pixmapFunction (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the name of the function used to load pixmaps into the
form window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setPixmapFunction">setPixmapFunction</a>().</p>


<h3 class="fn"><a name="removeResourceFile" />QDesignerFormWindowInterface.removeResourceFile (<i>self</i>, QString&#160;<i>path</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Removes the resource file at the specified <i>path</i> from the
list of those used by the form.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#resourceFiles">resourceFiles</a>()
and <a href="qdesignerformwindowinterface.html#resourceFilesChanged">resourceFilesChanged</a>().</p>


<h3 class="fn"><a name="resourceFiles" />QStringList QDesignerFormWindowInterface.resourceFiles (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns a list of paths to resource files that are currently
being used by the form window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#addResourceFile">addResourceFile</a>()
and <a href="qdesignerformwindowinterface.html#removeResourceFile">removeResourceFile</a>().</p>


<h3 class="fn"><a name="selectWidget" />QDesignerFormWindowInterface.selectWidget (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>widget</i>, bool&#160;<i>select</i>&#160;=&#160;True)</h3><p>This method is also a Qt slot with the C++ signature <tt>void selectWidget(QWidget *,bool = 1)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>If <i>select</i> is true, the given <i>widget</i> is selected;
otherwise the <i>widget</i> is deselected.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#clearSelection">clearSelection</a>()
and <a href="qdesignerformwindowinterface.html#selectionChanged">selectionChanged</a>().</p>


<h3 class="fn"><a name="setAuthor" />QDesignerFormWindowInterface.setAuthor (<i>self</i>, QString&#160;<i>author</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the details for the author or creator of the form to the
<i>author</i> specified.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#author">author</a>().</p>


<h3 class="fn"><a name="setComment" />QDesignerFormWindowInterface.setComment (<i>self</i>, QString&#160;<i>comment</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the information about the form to the <i>comment</i>
specified. This information should be a human-readable comment
about the form.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#comment">comment</a>().</p>


<h3 class="fn"><a name="setContents" />QDesignerFormWindowInterface.setContents (<i>self</i>, <a href="qiodevice.html">QIODevice</a>&#160;<i>dev</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the form's contents using data obtained from the given
<i>device</i>.</p>
<p>Data can be read from <a href="qfile.html">QFile</a> objects or
any other subclass of <a href="qiodevice.html">QIODevice</a>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#contents">contents</a>().</p>


<h3 class="fn"><a name="setContents-2" />QDesignerFormWindowInterface.setContents (<i>self</i>, QString&#160;<i>contents</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setContents(const QString&amp;)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the contents of the form using data read from the specified
<i>contents</i> string.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#contents">contents</a>().</p>


<h3 class="fn"><a name="setDirty" />QDesignerFormWindowInterface.setDirty (<i>self</i>, bool&#160;<i>dirty</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setDirty(bool)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>If <i>dirty</i> is true, the form window is marked as dirty,
meaning that it is modified but not saved. If <i>dirty</i> is
false, the form window is considered to be unmodified.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#isDirty">isDirty</a>().</p>


<h3 class="fn"><a name="setExportMacro" />QDesignerFormWindowInterface.setExportMacro (<i>self</i>, QString&#160;<i>exportMacro</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the form window's export macro to <i>exportMacro</i>. The
export macro is used when building a widget plugin to export the
form's interface to other components.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#exportMacro">exportMacro</a>().</p>


<h3 class="fn"><a name="setFeatures" />QDesignerFormWindowInterface.setFeatures (<i>self</i>, <a href="qdesignerformwindowinterface-feature.html">Feature</a>&#160;<i>f</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setFeatures(QDesignerFormWindowInterface::Feature)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Enables the specified <i>features</i> for the form window.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#features">features</a>() and
<a href="qdesignerformwindowinterface.html#featureChanged">featureChanged</a>().</p>


<h3 class="fn"><a name="setFileName" />QDesignerFormWindowInterface.setFileName (<i>self</i>, QString&#160;<i>fileName</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setFileName(const QString&amp;)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the file name for the form to the given
<i>fileName</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#fileName">fileName</a>() and
<a href="qdesignerformwindowinterface.html#fileNameChanged">fileNameChanged</a>().</p>


<h3 class="fn"><a name="setGrid" />QDesignerFormWindowInterface.setGrid (<i>self</i>, <a href="qpoint.html">QPoint</a>&#160;<i>grid</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setGrid(const QPoint&amp;)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the grid size for the form window to the point specified by
<i>grid</i>. In this function, the coordinates in the <a href="qpoint.html">QPoint</a> are used to specify the dimensions of a
rectangle in the grid.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#grid">grid</a>().</p>


<h3 class="fn"><a name="setIncludeHints" />QDesignerFormWindowInterface.setIncludeHints (<i>self</i>, QStringList&#160;<i>includeHints</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the header files that will be included in the form window's
associated UI file to the specified <i>includeHints</i>.</p>
<p>Header files may be local, i.e. relative to the project's
directory, <tt>"mywidget.h"</tt>, or global, i.e. part of Qt or the
compilers standard libraries: <tt>&lt;QtGui/QWidget&gt;</tt>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#includeHints">includeHints</a>().</p>


<h3 class="fn"><a name="setLayoutDefault" />QDesignerFormWindowInterface.setLayoutDefault (<i>self</i>, int&#160;<i>margin</i>, int&#160;<i>spacing</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the default <i>margin</i> and <i>spacing</i> for the form's
layout.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#layoutDefault">layoutDefault</a>().</p>


<h3 class="fn"><a name="setLayoutFunction" />QDesignerFormWindowInterface.setLayoutFunction (<i>self</i>, QString&#160;<i>margin</i>, QString&#160;<i>spacing</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the <i>margin</i> and <i>spacing</i> for the form's
layout.</p>
<p>The default layout properties will be replaced by the
corresponding layout functions when <tt>uic</tt> generates code for
the form, that is, if the functions are specified. This is useful
when different environments requires different layouts for the same
form.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#layoutFunction">layoutFunction</a>().</p>


<h3 class="fn"><a name="setMainContainer" />QDesignerFormWindowInterface.setMainContainer (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>mainContainer</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the main container widget on the form to the specified
<i>mainContainer</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#mainContainer">mainContainer</a>()
and <a href="qdesignerformwindowinterface.html#mainContainerChanged">mainContainerChanged</a>().</p>


<h3 class="fn"><a name="setPixmapFunction" />QDesignerFormWindowInterface.setPixmapFunction (<i>self</i>, QString&#160;<i>pixmapFunction</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the function used to load pixmaps into the form window to
the given <i>pixmapFunction</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#pixmapFunction">pixmapFunction</a>().</p>


<h3 class="fn"><a name="unmanageWidget" />QDesignerFormWindowInterface.unmanageWidget (<i>self</i>, <a href="qwidget.html">QWidget</a>&#160;<i>widget</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void unmanageWidget(QWidget *)</tt>.</p><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Instructs the form window not to manage the specified
<i>widget</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#aboutToUnmanageWidget">aboutToUnmanageWidget</a>()
and <a href="qdesignerformwindowinterface.html#widgetUnmanaged">widgetUnmanaged</a>().</p>


<hr /><h2>Qt Signal Documentation</h2><h3 class="fn"><a name="aboutToUnmanageWidget" />void aboutToUnmanageWidget (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a widget on the form is about to
become unmanaged. When this signal is emitted, the specified
<i>widget</i> is still managed, and a <a href="qdesignerformwindowinterface.html#widgetUnmanaged">widgetUnmanaged</a>()
signal will follow, indicating when it is no longer managed.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#unmanageWidget">unmanageWidget</a>()
and <a href="qdesignerformwindowinterface.html#isManaged">isManaged</a>().</p>


<h3 class="fn"><a name="activated" />void activated (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a widget is activated on the
form. The activated widget is specified by <i>widget</i>.</p>


<h3 class="fn"><a name="changed" />void changed ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a form is changed.</p>


<h3 class="fn"><a name="featureChanged" />void featureChanged (QDesignerFormWindowInterface::Feature)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a feature changes in the form.
The new feature is specified by <i>feature</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setFeatures">setFeatures</a>().</p>


<h3 class="fn"><a name="fileNameChanged" />void fileNameChanged (const QString&amp;)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever the file name of the form
changes. The new file name is specified by <i>fileName</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setFileName">setFileName</a>().</p>


<h3 class="fn"><a name="geometryChanged" />void geometryChanged ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever the form's geometry changes.</p>


<h3 class="fn"><a name="mainContainerChanged" />void mainContainerChanged (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever the main container changes. The
new container is specified by <i>mainContainer</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#setMainContainer">setMainContainer</a>().</p>


<h3 class="fn"><a name="objectRemoved" />void objectRemoved (QObject *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever an object (such as an action or
a <a href="qbuttongroup.html">QButtonGroup</a>) is removed from the
form. The object that was removed is specified by
<i>object</i>.</p>
<p>This function was introduced in Qt 4.5.</p>


<h3 class="fn"><a name="resourceFilesChanged" />void resourceFilesChanged ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever the list of resource files used
by the form changes.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#resourceFiles">resourceFiles</a>().</p>


<h3 class="fn"><a name="selectionChanged" />void selectionChanged ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever the selection in the form
changes.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#selectWidget">selectWidget</a>()
and <a href="qdesignerformwindowinterface.html#clearSelection">clearSelection</a>().</p>


<h3 class="fn"><a name="widgetManaged" />void widgetManaged (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a widget on the form becomes
managed. The newly managed widget is specified by
<i>widget</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#manageWidget">manageWidget</a>().</p>


<h3 class="fn"><a name="widgetRemoved" />void widgetRemoved (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a widget is removed from the
form. The widget that was removed is specified by
<i>widget</i>.</p>


<h3 class="fn"><a name="widgetUnmanaged" />void widgetUnmanaged (QWidget *)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted whenever a widget on the form becomes
unmanaged. The newly released widget is specified by
<i>widget</i>.</p>
<p><b>See also</b> <a href="qdesignerformwindowinterface.html#unmanageWidget">unmanageWidget</a>()
and <a href="qdesignerformwindowinterface.html#aboutToUnmanageWidget">aboutToUnmanageWidget</a>().</p>
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;snapshot-4.9.5-9eb6aac99275 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt&#160;4.8.3</td></tr></table></div></address></body></html>